/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.service.reliable.events;


import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.DataInputStream;
import java.io.DataOutputStream;
import java.io.IOException;
/** This is the invoice event issued by an entity upon detection of missing
    archival sequences. NAK events trigger the retransmission of the missed
    event.

    @author Shrideep Pallickara
    $Date$
    $Revision$
*/

public class RdNakInvoiceEntityEvent {
  private boolean singleNak=true;
  private int templateId;
  private int entityId;
  private long[] nakSequences;
  private long nakSequence;
  private long retransmissionId;
  private String moduleName = "RdNakInvoiceEntityEvent: ";

  /** Initialize the Nak Invoice Event */
  public RdNakInvoiceEntityEvent(int templateId, int entityId, 
				 long nakSequence) {
    singleNak=true;
    this.templateId = templateId;
    this.entityId = entityId;
    this.nakSequence = nakSequence;
    retransmissionId = System.currentTimeMillis();
  }

  /** Initialize the Nak Invoice Event */
  public RdNakInvoiceEntityEvent(int templateId, int entityId, 
				 long[] nakSequences) {
    singleNak=false;
    this.templateId = templateId;
    this.entityId = entityId;
    this.nakSequences = nakSequences;
    retransmissionId = System.currentTimeMillis();
  }
  
  public int getTemplateId() {
    return templateId;
  }
  
  public int getEntityId() {
    return entityId;
  }

  /** Allows us to inspect if the event contains a single naknowledgement or
      multiple ones */
  public boolean containsSingleNak() {
    return singleNak;
  }

  
  public long getNakSequenceNumber() {
    return nakSequence;
  }
  
  public long[] getNakSequenceNumbers() {
    return nakSequences;
  }

  public long getRetransmissionId() {
    return retransmissionId;
  }


  /** Reconstructing the original event from its serialized representation */
  public RdNakInvoiceEntityEvent(byte[] marshalledBytes) {
    ByteArrayInputStream baInputStream = 
      new ByteArrayInputStream(marshalledBytes);
    DataInputStream din = new DataInputStream(baInputStream);

    try {
      din.readByte(); /**ReliableDeliveryX.ENTITY_RDS_NAK_INVOICE_EVENT */
      
      templateId = din.readInt();
      entityId = din.readInt();

      singleNak = din.readBoolean();
      
      if (singleNak) {
	nakSequence = din.readLong();
      } else {
	int _seqLength = din.readInt();
	nakSequences = new long[_seqLength];
	for (int i=0; i < _seqLength; i++) {
	  nakSequences[i] = din.readLong();
	} /* end nak sequences */
	
      }/* end single nak */
      
      retransmissionId = din.readLong();
    } catch (IOException ioe) {
      System.out.println(moduleName + "Error while un-marshalling");
    }

  }

  /** Returns a serialized representation of the event bytes */
  public byte[] getBytes() {
    ByteArrayOutputStream baOutputStream = new ByteArrayOutputStream();
    DataOutputStream dout = new DataOutputStream(baOutputStream);
    byte[] marshalledBytes= null;

    try {                                              
      dout.writeByte(ReliableDeliveryExchange.ENTITY_RDS_NAK_INVOICE_EVENT);
      
      dout.writeInt(templateId);
      dout.writeInt(entityId);

      dout.writeBoolean(singleNak);
      
      if (singleNak) {
	dout.writeLong(nakSequence);
      } else {
	
	dout.writeInt(nakSequences.length);
	for (int i=0; i < nakSequences.length; i++) {
	  dout.writeLong(nakSequences[i]);
	} /* end nak sequences */

      }/* end single nak */

      dout.writeLong(retransmissionId);
      marshalledBytes = baOutputStream.toByteArray();
    } catch (IOException ioe) {
      System.out.println(moduleName + "Error while marshalling");
    }
    return marshalledBytes;
  }
  

  public String toString() {
    String stringRep = moduleName + "TemplateId=" + templateId + 
      ", EntityId=" + entityId + "NAK Sequences =";

    if (singleNak) {
      stringRep += ("[" + nakSequence + "]" );
    } else {
      for (int i = 0; i < nakSequences.length ; i++) {
	stringRep += ("[" + nakSequences[i] + "] " );
      }/*end for */
      
    }/*end singleNak */
    
    return stringRep;
  }

  /** This function is called by the processor */
  public void removeNakSequence(long sequenceNumber) {
    if (singleNak) {
      if (sequenceNumber == nakSequence) {
	nakSequence =0;
      }
      return;
    }
    boolean exists= false;
    for (int i=0; i<nakSequences.length; i++) {
      if (nakSequences[i] == sequenceNumber) {
	exists = true;
	break;
      }
    }

    if (!exists) {
      return;
    }

    long[] newNakSequences=null;
    if (exists) {
      newNakSequences = new long[nakSequences.length -1];
      int index=0;
      for (int i=0; i < nakSequences.length; i++) {
	if (nakSequences[i] != sequenceNumber) {
	  newNakSequences[index++] = nakSequences[i];
	}
      }/*end for */
    }/* end if(exists)*/
    
    if (newNakSequences.length == 1) {
      nakSequence = newNakSequences[0];
      singleNak=true;
      nakSequences = null;
      return;
    }
    
    nakSequences = newNakSequences;
  }
  
  public boolean containsNakInfo() {
    if (nakSequence == 0 && nakSequences == null) {
      return false;
    }
    return true;
  }

  public static void main(String[] args) {
    long[] missed = {0, 12, 23, 45};
    RdNakInvoiceEntityEvent nakInvoice = 
      new RdNakInvoiceEntityEvent(1234, 9876, missed);
      
    nakInvoice.getBytes();
    

  }

}

